Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-9940: Serverless Monitoring for Azure Functions #27294

Merged
merged 9 commits into from
Feb 13, 2025

Conversation

cswatt
Copy link
Contributor

@cswatt cswatt commented Jan 24, 2025

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@cswatt cswatt added the WORK IN PROGRESS No review needed, it's a wip ;) label Jan 24, 2025
@cswatt cswatt requested review from a team as code owners January 24, 2025 19:33
Copy link
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

Copy link
Contributor

@duncanpharvey duncanpharvey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for getting this started @cswatt! Let me know what you think about my suggestions.

Can we mention that we support runtime metrics and custom metrics and link the relevant documentation?

Could we also have more section (maybe under troubleshooting?) to document that if deploying to a Linux Consumption function with a Github Action that the "Using Azure Service Principal for RBAC as Deployment Credential" method needs to be used?

https://github.com/Azure/functions-action?tab=readme-ov-file#using-azure-service-principal-for-rbac-as-deployment-credential

content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
content/en/serverless/azure_functions/_index.md Outdated Show resolved Hide resolved
@cswatt cswatt added editorial review Waiting on a more in-depth review and removed WORK IN PROGRESS No review needed, it's a wip ;) labels Feb 10, 2025
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Feb 10, 2025
Copy link
Contributor

@duncanpharvey duncanpharvey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, Cecilia! I noticed a couple things, mostly questions I had based on not being familiar with how the code works 😅 Let me know when you'd like me to take a final look, and/or if there's anything else I can help you out with!

{{< /programming-lang >}}
{{< /programming-lang-wrapper >}}

3. **Deploy your function**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The numbering goes back to 3 here - just bump the numbers from here on in up by 2 and you're good to go 🙂

Comment on lines 62 to 63
4. (Optional) **Enable custom metrics**. See [Metric Submission: DogStatsD][3].
[1]: /tracing/trace_collection/automatic_instrumentation/?tab=singlestepinstrumentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if you saw this during your testing or if it's something odd going on on my end, but my local build insists on having this blank line to render the links properly:

Suggested change
4. (Optional) **Enable custom metrics**. See [Metric Submission: DogStatsD][3].
[1]: /tracing/trace_collection/automatic_instrumentation/?tab=singlestepinstrumentation
4. (Optional) **Enable custom metrics**. See [Metric Submission: DogStatsD][3].
[1]: /tracing/trace_collection/automatic_instrumentation/?tab=singlestepinstrumentation

5. **Configure Unified Service Tagging**. You can collect metrics from your Azure Functions by installing the [Datadog Azure integration][6]. To correlate these metrics with your traces, first set the `env`, `service`, and `version` tags on your resource in Azure. Then, configure the following environment variables. You can add custom tags as `DD_TAGS`.

```
DD_ENV="<ENVIRONMENT>"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to double check that these environment variables use quotation marks, but the ones in the previous step don't?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it's actually an interface that they'd use to add each of these... you bring up a good point, I'm going to reformat this

Copy link
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I find the environment variables a lot easier to scan in a table ✨

@cswatt
Copy link
Contributor Author

cswatt commented Feb 13, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 13, 2025

View all feedbacks in Devflow UI.
2025-02-13 19:29:24 UTC ℹ️ Start processing command /merge


2025-02-13 19:29:29 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in master is 7m.


2025-02-13 19:36:23 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit ab818a9 into master Feb 13, 2025
18 of 20 checks passed
@dd-mergequeue dd-mergequeue bot deleted the cswatt/azure_functions_svl branch February 13, 2025 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants